Libris Britannia 4/science library(b).zip/science library(b)/PROGRAMM/PROGEDIT/0344.ZIP/E88.DOC

Text File | 1986-07-08 | 25KB | 475 lines

               ┌───────────────────────────────────────┐
               │  * * * *   E88 TEXT EDITOR   * * * *  │
               │  --- Release P2.01 Documentation ---  │
               └───────────────────────────────────────┘

    The E88 text editor was written primarily to be used as an alternative
to the DOS supplied EDLIN line editor program. This editor is intended to
be a fast, compact, and easy to use screen editor for editing or creating
program source code. It is not a word processor and is not nearly as comp-
plicated to learn or use.

                      *   EQUIPMENT REQUIRMENTS   *

Computers supported:
    E88 supports the I.B.M. PC/XT, PCjr., and all true compatibles.
--------------------------------------------------------------------------
Operating systems:
    E88 is compatible with MS/PC DOS 2.00 or later.
--------------------------------------------------------------------------
Keyboard:
    The keyboard is BIOS supported which implies that it will function
normally according to the machine BIOS the program is used with. The Alt-
numeric keypad entry method is in effect if supported by the BIOS. This
method allows the user to enter any ASCII code by holding the [Alt] key
and typing in the ASCII code number on the numeric keypad.
--------------------------------------------------------------------------
Video display:
    E88 supports both the color graphics and monochrome display adapters.
This editor drives these display adapters directly, which results in very
high speed display control. This feature may cause problems when run on
machines that are not I.B.M. display compatible.
--------------------------------------------------------------------------
Disk control:
    All disk functions are controlled through standard MS-DOS function
calls. The DOS pathname/file handle protocol of versions 2.00 and later
is now supported. Any valid path and filename can now be used in the file
specification. This is a change from version 1.0 which was written to run
under older versions of D.O.S.
--------------------------------------------------------------------------
File type:
    E88 provides standard ASCII input and output. This is the file type
required by most assemblers and compilers. It is compatible with all known
ASCII file types at the time of this release.
--------------------------------------------------------------------------
Printer:
    The printer output from E88 is standard ASCII text which should be
acceptable to all printers. It should also be noted that no filtering is
done on the text when it is sent to the printer. The user may specify any
special codes such as escape codes directly on a line in the file and
force the printer to do whatever he desires. Some special characters in
the I.B.M. extended character set (above ASCII 127) as well as some control
characters (below ASCII 32) may not be acceptable to some printers and
could cause unusual looking printouts.
--------------------------------------------------------------------------

                          *   USING E88   *

Filenames:
    Standard DOS notation is acceptable .(Pathnames are now supported)
note: .ASM is the default extension for the file, but the user may
      specify any default desired through the setup process.(more later)

example:  C:MYPROG.TXT <ENTER> would load MYPROG.TXT from drive C:
example: MYPROG <ENTER> would load MYPROG.ASM from the default drive.

--------------------------------------------------------------------------
                        *   THE EDIT SCREEN   *

Top line information:

FILENAME    LINE       COL      FREE         MODE           COM KEY:[F1]
current   │ text   │ cursor │  80 char. │ current mode  │ just a reminder
file      │ line#  │ column │ lines free│   EDIT etc.   │ for command modes

Note: The path is not shown on the top line filename area, however
      selecting the change filename option (discussed later) will display
      the current path.

Note: The indicated line number represents the current line that the cursor
      resides on IN THE FILE being edited. A line consist of a screen line.

      example:  ---> this is supposed to represent text on the screen ok
                ---> text text text text text text more text etc.. on an on
                ---> new line of text across screen starts at arrow on left

      represents 3 lines of the text file
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

The rest of the screen:

    The remainder of the screen contains the text file that is being edited
    and also contains a --->, nothing or the word "Free" in the first five
    columns of the screen on each line. An arrow ---> means that this is
    the beginning of a new line. If the first five columns are blank, the
    line is an extension of the previous line. There is no limit on line
    length. It is the user's responsibility to insure that the length does
    not exceed that which is acceptable to the assembler or compiler that
    the text file is to be used with. The word "Free" in the left 5 columns
    indicates that this line is available but not in use. The appearance
    of the first line marked "Free" is the physical end of file. Although
    it is possible to type on these free lines, any text present on these
    lines will not be saved to disk. This feature will allow the user to
    make notes on these lines if desired, although these notes will not be
    saved or reloaded.

Note: Extended lines are counted as a line when refering to E88's line
      number or free lines remaining imformation. They are however saved
      to disk as being one complete line of text.

      Example: ---> this represents a line of text on the E88 editor screen
                    which is extended ( notice no arrow ) into this line

      * 2 lines to E88 but only one long line to the disk file.

--------------------------------------------------------------------------
                       *   PROGRAM CONTROL   *

    The E88 editor simulates a long scroll of text which can be moved very
quickly. The following is an overview of how this control is obtained.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

The numeric keypad:

    The numeric keypad provides standard cursor as well as screen control.

[Up]  [Dn]  [Lt]  [Rt]
    The four arrow keys provide cursor control as expected but also provide
    screen control. Whenever a cursor movement would cause the cursor to be
    positioned off the top or bottom of the screen an automatic screen
    scroll will occur. This includes end wrap for the left and right arrows
    as well as simply holding the up and down arrow keys to force a scroll.

[Pg Up]  [Pg Dn]
    The page up and page down keys will cause an immediate 24 line scroll
    to the preceeding or following page of text.

[Home]  [End]
    The home and end keys will cause a 1 line scroll up and down.

[Ctrl]  [Home]
    The key combination of [Ctrl] [Home] will home the cursor.

[Ctrl]  [End]
    This combination will place the cursor at the end of the current line.

[Ins]
    Toggles the editor into and out of insert character mode. (more later)

[Del]
    Deletes the character at current cursor position.
---------------------------------------------------------------------------

The function keys:

    The function keys provide access to the command modes as well as some
screen and edit features as well.

[F1]
    F1 calls the main command menu window, discussed in detail later.

[F2]
    F2 calls the printer !?  Make sure the printer is on (if it isn't, E88
    will wait until it is). Place the cursor on the line where the print-
    out is to start and press [F2]. The printer will print lines and the
    cursor will move and the screen will scroll until any key is pressed or
    the end of file is reached. The cursor indicates the line currently
    being printed. Termination of the print will restore the screen and
    cursor to their previous positions.

[Alt.] [F2]
    This key combination causes the same action as described above except
    that the arrows are not printed. This provides a cleaner looking print-
    out when editing DOC files and other text files.

[F3]  [F4]  [F5]  [F6]  [F7]  [F8]
    F3 through F8 are called pagers. Pressing these keys will cause the
    text to scroll instantly to a page that has been preset by the user.
    To preset the page for each key, simply scroll to the desired page,
    hold the shift key down, and press F3 to F8. That key is then set
    to the displayed page and will return to that point from anywhere in
    the text. These keys will remain set until reset, which can be done as
    often as necessary.

Note: Upon startup the pager keys are set up to split the file into equal
      parts. [F1] points at the 1st page and [F8] points at the last page
      in the file with all others equally spaced in between. This is a new
      feature of version 2.00 which allows rapid access to any area in the
      file.

[Alt.] [F8]
    This is the load buffer command key combination. When this command is
    issued, the line that the cursor is on will be loaded into a 32 line
    buffer. The cursor will then move to the next line down, which, if the
    user desires, may also be loaded. Up to 32 lines may be stored in this
    manner and recovered with the [F10] key. The use of this command in
    combination with the [F10] key may used to do a block copy of up to
    32 lines at a time.

[F9]
    F9 will insert a line into the text directly above the line that the
    cursor is on when the key is pressed.

[Alt.] [F9]
    This key combination will toggle the attribute of the current line.
    It will change an extended line into a new line or a new line into an
    extended line. This can be used to seperate or join lines in the file.

[F10]
    This key will automatically insert a line of text which has been
    saved in the 32 line buffer. The insert will occur at the current
    cursor position in the same manner that the [F9] key effects an
    insert. Lines may be saved into the buffer by the [Alt.] [F8] load
    buffer command or by the [Alt.] [F10] delete line command.

[Alt.] [F10]
    This key combination is the delete line command. When this command is
    used the current line will be deleted from the screen and the file
    will scroll up to fill the vacated space. The deleted line is not lost
    forever however, it is placed in a 32 line circular buffer. The last
    32 deleted lines may be recovered by simply pressing [F10] after
    positioning the cursor at the desired insert position. Using the key
    sequences of [Alt.] [F10] and [F10] in combination can be used to move
    a block of text (up to 32 lines at a time) from one place in the file
    to another.

NOTE: The circular buffer
    The circular buffer referred to in the previous function descriptions
    is used as temporary storage area for deleted and saved lines. The
    buffer is always available to accept 32 new lines. Circular implies
    that the last 32 lines either saved or deleted may always be recovered
    from the buffer. The lines are stored using "last in - first out" or
    "STACK" logic.

┌─────────────────┐
│ [Ctrl.] [F1-F10]│
├─────────────────┴──────────────────────────────────────────────────────┐
│   These key combinations print a special character which has been      │
│   preprogrammed by the user for the particular function key. The       │
│   programming of these keys is discussed later in the setup window     │
│   instructions. The default character set for these keys is the set of │
│   line graphics characters and the use of them is demonstrated by the  │
│   nice outlining around this paragraph.                                │
└────────────────────────────────────────────────────────────────────────┘

---------------------------------------------------------------------------

Some other keys:

[ENTER]
    The enter key is used much as with any other editor. When typing
    in text, hitting [ENTER] will cause the cursor to move to the start of
    the next line, inserting a line if it is at the end of file. [ENTER]
    also resets the tabs and records in memory the current text screen.
    There is one difference with this editor to many others including the
    Microsoft BASIC program editor. It is NOT necessary to press [ENTER]
    to insure that your screen changes have been preserved. The program
    logic automatically detects a screen change and records the new screen.
    This prevents the old BASIC problem of forgetting to press enter and
    having to re-type a change.

[Tab]....located below escape in upper left on the I.B.M. keyboard
    The tab key tabs the cursor to the user preset tabs.

[Shift]*[Tab]
    This key combination of shift and the tab key will set a tab on the
    screen. E88 supports 20 tab positions which can be set to function
    in almost any maner the user desires.
    To set the tabs:
  (1.) Press [ENTER] (this clears the tab count)
  (2.) Move the cursor to the desired tab position.
  (3.) Hold down a shift key and press the tab key.
  (4.) Tab 1 is now set and the next tab is ready to be set.
  (5.) Repeat this procedure until the speaker beeps if desired.

NOTES on the tab function :
1.  The speaker will beep when the 20th tab is set. When the speaker beeps
    this indicates that the count is about to start over at the first tab.
    The tab function on both tabbing and setting the tabs is a rollover
    procedure. When the last tab is reached then the program will start
    over with the first tab again. There is no beep during normal tabbing,
    the beep occurs only when setting the tabs.

2.  The tabs can be set in any order desired. The cursor does not have to
    tab from left to right. For example 38,24,36,5,10,15,38,24,36,71,∙∙∙
    is a perfectly legal tab setup. The default tab setup is a repeating
    sequence of 5,15,25,45,5,15,25,45,5,15,25,45 and so on.

3.  Any tab can be set at any time. Simply clear the tab count by pressing
    [ENTER]. Tab the cursor normally with the tab key while counting the
    number of tabs. When the desired tab is reached, position the cursor
    on the proper column and perform step 3 above.

4.  The tab setup is saved within the setup file E88SETUP.DEF which is
    discussed later in the command mode section. To save the tab setup,
    the user must go into setup mode. (See command mode option "E.")

[Ins]
    More on the insert key. The insert and delete character keys work
    exactly like they do in the BASIC program editor. The insert key
    toggles on and off. Insert mode is indicated by a "fat" cursor. When
    insert is enabled, characters will be inserted into the line at the
    current cursor position while all characters to the right are moved and
    wrapped around to the next line if necessary. The editor will also
    insert an extension onto the line if needed. The insert mode is toggled
    off with any screen or cursor movement.

Alphanumeric keys:
    Type as usual.
---------------------------------------------------------------------------
                        *   COMMAND MODES   *

    Pressing function key [F1] will call E88's command window. The command
mode will allow the user to save,backup,or exit from editing, as well as
setup the editor defaults. The following information is provided to serve
as a guide to the command mode functions.

COMMANDS:

[Esc]
    The escape key will return to edit mode.

(A.) END the edit and save this file
    This option will save the file to the drive and filename displayed in
    the upper left corner of the screen. The program will return to DOS
    when the save is complete.

(B.) BACKUP (create filename.bak)
    This option will create a backup file using the displayed filename (as
    above) but with the extension of BAK. This option can be used as often
    as necessary during the edit to insure that a loss of power or other
    unthinkable event would not cause a loss of data. Note that no backup
    file is automatically produced as with EDLIN.

(C.) CHANGE filename (for saving)
    This option allows the user to save a file under a different name.
    This is useful in cases where a standard format is used to set up
    a source file. The user can load the standard file, change the name,
    and save the edited file without effecting the standard load file.
    When pressed, the current file specification will be displayed. The
    user may then press [ENTER] to return with no change or enter the
    new file specification.

(D.) HELP
    This option provides a quick reference to most of the key functions
    as well as some very important program information. Press the
    escape key to return to editing.

(E.) SETUP (set default parameters)
    This option allows the user to setup the program default parameters.
    When this option is selected, a setup window will replace the command
    window. This window will present the user with a number of keys which
    will change the program parameters. If the user so desires, the setup
    will be saved to the current directory in a file named E88SETUP.DEF.
    E88 searches for this file when it is executed and if found, configures
    itself to the specified parameters. If this file is not found, then E88
    uses it's internal defaults. It is possible to create several setup
    files in different directorys. This will allow the user to taylor the
    editor to the job at hand.
    The file, E88SETUP.DEF, can only be created from the setup window.

 A NOTE ABOUT COLOR SELECTION :
    Each time a color select key is pressed, the color will change on the
    screen in the sequence of black, blue, green, cyan, red, magenta, yell-
    ow and white. Foreground and border colors will provide 16 increments
    of this sequence with the last 8 increments being the high intensity
    color set. Background colors increment 8 times. When the sequence is
    complete it repeats. When using E88 on a monochrome display adapter it
    will be necessary for the user to press the setup keys many times to
    effect a change. This is due to the limited number of attributes that
    the adapter is capable of displaying. The border color select option
    is also not functional when using a monochrome adapter.

 OTHER NOTABLE FEATURES OF THE SETUP WINDOW:
    E88 version 2.00 has two added options in setup mode. The user may now
    setup the default filename extension and also program the 10 function
    keys to provide special characters when the [Ctrl.] [F1-F10] key
    combinations are pressed. These options are implemented by selecting
    options `H' and `I' from the setup window.

 OPTION (H):
    When the `H' option is selected, the window will be cleared and the
    user will be prompted for a new filename extension.  A new extension
    must then be entered. The extension must consist of 3 characters
    although any three may be used including blank characters. Refer to the
    D.O.S. manual for information regarding valid filename extensions.  The
    new extension will be saved only if the program setup is saved from the
    main setup window.

 OPTION (I):
    Selecting option `I' will open a setup window allowing the user to
    program the 10 function keys for special characters. The prompt
    will display the currently defined character for that key and request
    a new character be entered. The user may then enter the character or
    simply press [ENTER] to leave that key unchanged. The program will
    cycle through all ten keys and then automatically return to the main
    setup menu. Note that the [Alt.] keypad method of entering a special
    ASCII character can be used. By holding the Alt. key and typing in the
    ASCII code number of the character desired then releasing the Alt. key,
    any ASCII character may be defined. As with option `H' above, these
    changes will only be saved by pressing [ENTER] from the main setup
    window.

(F.) QUIT * RETURN TO DOS * NO SAVE
    This option terminates the editor and returns control to DOS. The file
    is NOT saved. WARNING: There is no second chance!! When this key is
    hit, it's all over. This program is for programmers not button pushers.
--------------------------------------------------------------------------
                      *  STARTUP  OPTIONS  *

    E88 may be started by two methods. The user may simply type E88 [ENTER]
and wait for the program to prompt for the edit filename. Or the filename
may be entered on the D.O.S. command line. The default extension that is
selected through the setup window is in effect for both methods.

    The program also supports one special option that may be specified on
startup. The /B option will cause the screen blanking feature to be turned
off. This is useful when the program is used on machines that have the
newer display controller chips. It eliminates the "blinking" associated
with the screen scrolling. To test the use of this feature, simply start
E88 using the /B option and check for screen "fetches" when doing page up
and page down commands. If the "fetches" appear then the option should not
be used.

Examples:
          E88 [ENTER]     would start E88 and prompt for the filename.
          E88 /B [ENTER]  same as above but without screen blanking.
          E88 E88.DOC     would start E88 and load E88.DOC for editing.
          E88 /B MYPROG   would load myprog.(default ext.) with no blanking
          E88 \path\ MYPROG  loads MYPROG.def from the pathed directory.

* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

Special note:  E88 version 2.00 is written entirely in assembler language
               using the Microsoft Macro Assembler version 4.00 . It is
               completely compatible with this assembler as well. I highly
               recommend this assembler because it was a major factor in
               making this update possible. The source code for E88 is
               quite long and as one might imagine, takes a long time to
               assemble. Or I should say, it used to take a long time. MASM
               4.00 simply "smokes" any other assembler I've tried. My
               thanks and congratulations to Microsoft on an excellent
               product.

Benchmark:     Total source code .... 110,021 bytes in 3 files
               Total source lines ... 2175
               Total of all lines ... 2847
               Total symbols ........ 520
               Total assembly time 1 minute 21 seconds, files on ram disk
               Assembled using standard defaults with /A/Z/V options

* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Special thanks to Van M. Arnold and Thomas O. Ford who helped with the
testing and documentation of E88.
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
───────────────────────────────────────────────────────────────────────────

I.B.M., I.B.M. PC, I.B.M. XT, PCjr, and PC DOS are registered trademarks of
International Business Machines Corporation.

Microsoft, Microsoft BASIC, Microsoft Macro Assembler, and MS-DOS are
registered trademarks of Microsoft Corporation.

(C.) Copyright 1985,1986  E.D. Wooten Jr.   West Point, Mississippi  39773

NOTE: The author accepts NO LIABILITY whatsoever involving the use of this
      program. Although I have done extensive testing and debugging of this
      program to insure that it will not cause any problems to end users,
      it should be noted that this is public domain software and that the
      use, reproduction, and distribution is beyond my control. In short:..
                      *  USE AT YOUR OWN RISK  *
                                                     Emery D. Wooten Jr.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%> THE <%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%> END <%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%